<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<title>DRV_SST26_PageWrite Function</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="Doc-O-Matic" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="STYLESHEET" href="default.css" type="text/css" />

<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoadEx('frames.html', 'topic', '00548.html');" onmousedown="onBodyMouseDown();">

<!-- Begin Popups -->

<!-- End Popups -->

<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00143.html" target="topic">SQI Flash Driver Libraries Help</a> &gt; <a href="00152.html" target="topic">SST26 Driver Library Help</a> &gt; <a href="00153.html" target="topic">Library Interface</a> &gt; c) Transfer Functions &gt; <a href="00548.html" target="topic">DRV_SST26_PageWrite Function</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element1">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element2">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00530.html" target="topic">Previous</a> | <a href="00153.html" target="topic">Up</a> | <a href="00549.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_SST26_PageWrite@DRV_HANDLE@void *@uint32_t Topic Title: DRV_SST26_PageWrite Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table><div class="Element5">
DRV_SST26_PageWrite Function</div>
</div>
</div>

<!-- End Page Header -->

<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">

<!-- Begin Page Content -->
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
This function schedules a non-blocking write operation for writing maximum one page of data into flash memory.&nbsp;</p>
<p class="Element10">
The requesting client should call <a href="00557.html" target="topic">DRV_SST26_TransferStatusGet</a>() API to know the current status of the request.&nbsp;</p>
<p class="Element10">
The request is sent in QUAD_MODE to flash device.</p></div>
</div>
<a name="43"></a><div class="Element99">
C</div>
<div class="Element101"><div class="Element100"><pre class="Element100"><strong><span style="color: #000080">bool</span></strong> <strong><span style="color: #000000">DRV_SST26_PageWrite</span></strong>(
    <strong><span style="color: #000080">const</span></strong> <a href="00257.html" target="topic">DRV_HANDLE</a> <strong><span style="color: #000000">handle</span></strong>, 
    <strong><span style="color: #000080">void</span></strong> * <strong><span style="color: #000000">tx_data</span></strong>, 
    uint32_t <strong><span style="color: #000000">address</span></strong>
);</pre></div></div>
<a name="507265636F6E646974696F6E73"></a><div class="Element14">
Preconditions</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
The <a href="00547.html" target="topic">DRV_SST26_Open</a>() routine must have been called for the specified SST26 driver instance.&nbsp;</p>
<p class="Element10">
The flash address location which has to be written, must have been erased before using the SST26_xxxErase() routine.&nbsp;</p>
<p class="Element10">
The flash address has to be a Page aligned address.</p></div>
</div>
<a name="506172616D6574657273"></a><div class="Element14">
Parameters</div>
<div class="Element11">
<div class="Element10">
<div class="Element312">
<div class="TableDiv">
<table cellspacing="0" class="Table3">
<tr>
<td class="Element300" valign="top" width="35%">
<div class="Element301">
Parameters&nbsp;</div></td><td class="Element304" valign="top" width="65%">
<div class="Element305">
Description&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
handle&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
A valid open-instance handle, returned from the driver's open routine<br>&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
*tx_data&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
The source buffer containing data to be programmed into SST26 Flash<br>&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
tx_data_length&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Total number of bytes to be written. should not be greater than page size<br>&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
address&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Write memory start address from where the data should be written&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<a name="52657475726E73"></a><div class="Element14">
Returns</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
false</p>
<ul class="Element630">
<li class="Element600">if Write enable fails before sending sector erase command to flash</li>
<li class="Element600">if write command itself fails</li>
</ul><p class="Element10">
&nbsp;</p>
<p class="Element10">
true</p>
<ul class="Element630">
<li class="Element600">if the write request is successfully sent to the flash</li>
</ul></div>
</div>
<a name="52656D61726B73"></a><div class="Element14">
Remarks</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
None.</p></div>
</div>
<a name="4578616D706C65"></a><div class="Element14">
Example</div>
<div class="Element11">
<div class="Element10">
<div class="Element13"><div class="Element12"><pre class="Element12">
<strong><span style="color: #000080">#define</span></strong> PAGE_SIZE    256
<strong><span style="color: #000080">#define</span></strong> BUFFER_SIZE  1024
<strong><span style="color: #000080">#define</span></strong> MEM_ADDRESS  0x0

<a href="00257.html" target="topic">DRV_HANDLE</a> handle;  <i><span style="color: #008000">// Returned from DRV_SST26_Open</span></i>
uint8_t writeBuffer[BUFFER_SIZE];
<strong><span style="color: #000080">bool</span></strong> status = <strong><span style="color: #000080">false</span></strong>;

<strong><span style="color: #000080">if</span></strong>(<strong><span style="color: #000080">false</span></strong> == <a href="00551.html" target="topic">DRV_SST26_SectorErase</a>(handle))
{
    <i><span style="color: #008000">// Error handling here</span></i>
}

<i><span style="color: #008000">// Wait for erase to be completed</span></i>
<strong><span style="color: #000080">while</span></strong>(DRV_SST26_TRANSFER_BUSY == <a href="00557.html" target="topic">DRV_SST26_TransferStatusGet</a>(handle));

<strong><span style="color: #000080">for</span></strong> (uint32_t j = 0; j &lt; BUFFER_SIZE; j += PAGE_SIZE)
{
    <strong><span style="color: #000080">if</span></strong> (<strong><span style="color: #000080">true</span></strong> != DRV_SST26_PageWrite(handle, (<strong><span style="color: #000080">void</span></strong> *)&amp;writeBuffer[j], (MEM_ADDRESS + j)))
    {
        status = <strong><span style="color: #000080">false</span></strong>;
        <strong><span style="color: #000080">break</span></strong>;
    }

    <i><span style="color: #008000">// Wait for write to be completed</span></i>
    <strong><span style="color: #000080">while</span></strong>(DRV_SST26_TRANSFER_BUSY == <a href="00557.html" target="topic">DRV_SST26_TransferStatusGet</a>(handle));
    status = <strong><span style="color: #000080">true</span></strong>;
}

<strong><span style="color: #000080">if</span></strong>(status == <strong><span style="color: #000080">false</span></strong>)
{
    <i><span style="color: #008000">// Error handling here</span></i>
}
</pre></div></div>
</div>
</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00143.html" target="topic">SQI Flash Driver Libraries Help</a> &gt; <a href="00152.html" target="topic">SST26 Driver Library Help</a> &gt; <a href="00153.html" target="topic">Library Interface</a> &gt; c) Transfer Functions &gt; <a href="00548.html" target="topic">DRV_SST26_PageWrite Function</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element3">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element4">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00530.html" target="topic">Previous</a> | <a href="00153.html" target="topic">Up</a> | <a href="00549.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_SST26_PageWrite@DRV_HANDLE@void *@uint32_t Topic Title: DRV_SST26_PageWrite Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table></div>

<!-- End Page Footer -->
</div>
</div>

<!-- End Client Area -->
</body></html>